#!/bin/sh
#
# ocf:pacemaker:remote OCF resource agent
#
# Copyright 2013-2019 the Pacemaker project contributors
#
# The version control history for this file may have further details.
#
# This source code is licensed under the GNU General Public License version 2
# (GPLv2) WITHOUT ANY WARRANTY.
#

# This script provides metadata for Pacemaker's internal remote agent.
# Outside of acting as a placeholder so the agent can be indexed, and
# providing metadata, this script should never be invoked. The actual
# functionality behind the remote connection lives within Pacemaker's
# controller daemon.
#
#######################################################################
# Initialization:

: ${OCF_FUNCTIONS:="${OCF_ROOT}/resource.d/heartbeat/.ocf-shellfuncs"}
. "${OCF_FUNCTIONS}"
: ${__OCF_ACTION:="$1"}

#######################################################################

meta_data() {
    cat <<END
<?xml version="1.0"?>
<!DOCTYPE resource-agent SYSTEM "ra-api-1.dtd">
<resource-agent name="remote" version="0.1">
<version>1.0</version>
<shortdesc lang="en">remote resource agent</shortdesc>
  <parameters>
    <parameter name="server" unique="1">
    <longdesc lang="en">
       Server location to connect to.  This can be an ip address or hostname.
    </longdesc>
    <shortdesc lang="en">Server location</shortdesc>
    <content type="string"/>
    </parameter>
    <parameter name="port">
    <longdesc lang="en">
       tcp port to connect to.
    </longdesc>
    <shortdesc lang="en">tcp port</shortdesc>
    <content type="string" default="3121"/>
    </parameter>
    <parameter name="reconnect_interval" unique="0">
    <longdesc lang="en">
       Interval in seconds at which Pacemaker will attempt to reconnect to a
       remote node after an active connection to the remote node has been
       severed. When this value is nonzero, Pacemaker will retry the connection
       indefinitely, at the specified interval. As with any time-based actions,
       this is not guaranteed to be checked more frequently than the value of
       the cluster-recheck-interval cluster option.
    </longdesc>
    <shortdesc lang="en">reconnect interval</shortdesc>
    <content type="string" default="0"/>
    </parameter>
  </parameters>
  <actions>
    <action name="start"   timeout="60s" />
    <action name="stop"    timeout="60s" />
    <action name="reload"  timeout="60s" />
    <action name="monitor"    timeout="30s" />
    <action name="migrate_to"   timeout="60s" />
    <action name="migrate_from" timeout="60s" />
    <action name="meta-data"  timeout="5s" />
  </actions>
</resource-agent>
END
}

#######################################################################

remote_usage() {
    cat <<END
usage: $0 {meta-data}

Expects to have a fully populated OCF RA-compliant environment set.
END
}

remote_unsupported() {
    ocf_log info "The ocf:pacemaker:remote agent should not be directly invoked except for meta-data action"
    return $OCF_ERR_GENERIC
}

case $__OCF_ACTION in
meta-data)      meta_data
                exit $OCF_SUCCESS
                ;;
start)          remote_unsupported;;
stop)           remote_unsupported;;
monitor)        remote_unsupported;;
migrate_to)     remote_unsupported;;
migrate_from)   remote_unsupported;;
reload)         remote_unsupported;;
validate-all)   remote_unsupported;;
usage|help)     remote_usage
                exit $OCF_SUCCESS
                ;;
*)              remote_usage
                exit $OCF_ERR_UNIMPLEMENTED
                ;;
esac
rc=$?
ocf_log debug "${OCF_RESOURCE_INSTANCE} $__OCF_ACTION : $rc"
exit $rc

# vim: set filetype=sh expandtab tabstop=4 softtabstop=4 shiftwidth=4 textwidth=80:
